
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Calculations &#8212; iprPy 0.10.2 documentation</title>
    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <script type="text/javascript" src="../_static/language_data.js"></script>
    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Running a single calculation" href="single.html" />
    <link rel="prev" title="iprPy Package Components" href="../overview.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="single.html" title="Running a single calculation"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../overview.html" title="iprPy Package Components"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">iprPy 0.10.2 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="calculations">
<h1>Calculations<a class="headerlink" href="#calculations" title="Permalink to this headline">¶</a></h1>
<p>The iprPy framework is designed around running calculations.  Each implemented
calculation can be accessed and executed in a variety of ways allowing for the
calculations to be easily used for different situations.  Each calculation
exists in two forms: a Python script and a Jupyter Notebook.  The functions in
the Jupyter Notebook are copied directly from the Python script to ensure that
the code remains consistent.</p>
<p>Additionally, high-throughput capabilities are built around the Python scripts
allowing numerous runs to be prepared and executed in series.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="single.html">Running a single calculation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="single.html#calculation-script">Calculation script</a></li>
<li class="toctree-l2"><a class="reference internal" href="single.html#call-from-python">Call from Python</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook.html">Run a Jupyter Calculation Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="htp.html">High-Throughput Calculation Execution</a><ul>
<li class="toctree-l2"><a class="reference internal" href="htp.html#define-databases-and-run-directories">Define databases and run directories</a></li>
<li class="toctree-l2"><a class="reference internal" href="htp.html#copy-references-to-a-database">Copy references to a database</a></li>
<li class="toctree-l2"><a class="reference internal" href="htp.html#prepare-calculations">Prepare calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="htp.html#executing-calculations-with-runners">Executing calculations with runners</a></li>
<li class="toctree-l2"><a class="reference internal" href="htp.html#additional-tools-for-database-access-and-manipulation">Additional tools for database access and manipulation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inline.html">Command Line Actions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="inline.html#define">Define</a></li>
<li class="toctree-l2"><a class="reference internal" href="inline.html#build">Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="inline.html#prepare">Prepare</a></li>
<li class="toctree-l2"><a class="reference internal" href="inline.html#runner">Runner</a></li>
<li class="toctree-l2"><a class="reference internal" href="inline.html#other">Other</a></li>
</ul>
</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="../overview.html"
                        title="previous chapter">iprPy Package Components</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="single.html"
                        title="next chapter">Running a single calculation</a></p>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="single.html" title="Running a single calculation"
             >next</a> |</li>
        <li class="right" >
          <a href="../overview.html" title="iprPy Package Components"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">iprPy 0.10.2 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
    </div>
  </body>
</html>